package com.stone.boot.stoneboot.module.databasedocument.vo;

import lombok.Data;

import javax.validation.constraints.NotBlank;
import java.util.List;

/**
 * 文档生成请求数据传输对象
 * 该类用于外部系统接口请求参数的封装，以便在电子公文系统中生成操作手册
 */
@Data
public class GeneratorDocumentReqVO {

    /**
     * 文档生成器的访问URL
     * 用于指定文档生成器的服务地址
     */
    @NotBlank(message = "ip 不能为空！")
    private String ip;

    /**
     * 端口号
     */
    private String port;

    /**
     * 文档生成器的用户名
     * 用于认证访问文档生成器服务的用户身份
     */
    private String username;

    /**
     * 文档生成器的密码
     * 用于认证访问文档生成器服务的用户身份，与用户名配合使用
     */
    private String password;

    /**
     * 数据库表名
     * 指定要处理的数据表名称
     */
    private String tableName;

    /**
     * 文档输出路径
     */
    private String outputPath;

    /**
     * 忽略前缀
     * 指定处理时应忽略的字符串前缀
     */
    private List<String> ignorePrefixes;

    /**
     * 忽略后缀
     * 指定处理时应忽略的字符串后缀
     */
    private List<String> ignoreSuffixes;

    /**
     * 待生成的文档名称
     * 用于指定将要生成的文档的名称，以便于文档的识别与管理
     */
    private String docName;

    /**
     * 待生成文档的版本信息
     * 用于指定生成文档的版本，以便于文档的版本控制与更新
     */
    private String version;

    /**
     * 文档的描述信息
     * 用于提供生成文档的详细描述，帮助理解文档的内容与用途
     */
    private String description;
}

